<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfTextGtkBuffer</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.0">
<link rel="home" href="index.html" title="libinftextgtk-0.4 Reference Manual">
<link rel="up" href="ch01.html" title="libinftextgtk API">
<link rel="prev" href="ch01.html" title="libinftextgtk API">
<link rel="next" href="InfTextGtkHueChooser.html" title="InfTextGtkHueChooser">
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="ch01.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libinftextgtk-0.4 Reference Manual</th>
<td><a accesskey="n" href="InfTextGtkHueChooser.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#InfTextGtkBuffer.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#InfTextGtkBuffer.description" class="shortcut">Description</a>
                   | 
                  <a href="#InfTextGtkBuffer.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#InfTextGtkBuffer.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
                   | 
                  <a href="#InfTextGtkBuffer.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry" title="InfTextGtkBuffer">
<a name="InfTextGtkBuffer"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfTextGtkBuffer.top_of_page"></a>InfTextGtkBuffer</span></h2>
<p>InfTextGtkBuffer</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="InfTextGtkBuffer.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">                    <a class="link" href="InfTextGtkBuffer.html#InfTextGtkBuffer-struct" title="InfTextGtkBuffer">InfTextGtkBuffer</a>;
<a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="returnvalue">InfTextGtkBuffer</span></a> *  <a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-new" title="inf_text_gtk_buffer_new ()">inf_text_gtk_buffer_new</a>             (<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/GtkTextBuffer.html"><span class="type">GtkTextBuffer</span></a> *buffer</code></em>,
                                                         <em class="parameter"><code><a href="../libinfinity-0.4/InfUserTable.html"><span class="type">InfUserTable</span></a> *user_table</code></em>);
<a href="http://library.gnome.org/devel/gtk/unstable/GtkTextBuffer.html"><span class="returnvalue">GtkTextBuffer</span></a> *     <a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-get-text-buffer" title="inf_text_gtk_buffer_get_text_buffer ()">inf_text_gtk_buffer_get_text_buffer</a> (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-set-active-user" title="inf_text_gtk_buffer_set_active_user ()">inf_text_gtk_buffer_set_active_user</a> (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>,
                                                         <em class="parameter"><code><a href="../libinftext-0.4/InfTextUser.html"><span class="type">InfTextUser</span></a> *user</code></em>);
<a href="../libinftext-0.4/InfTextUser.html"><span class="returnvalue">InfTextUser</span></a> *       <a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-get-active-user" title="inf_text_gtk_buffer_get_active_user ()">inf_text_gtk_buffer_get_active_user</a> (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>);
<a href="../libinftext-0.4/InfTextUser.html"><span class="returnvalue">InfTextUser</span></a> *       <a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-get-author" title="inf_text_gtk_buffer_get_author ()">inf_text_gtk_buffer_get_author</a>      (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><span class="type">GtkTextIter</span></a> *location</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-is-author-toggle" title="inf_text_gtk_buffer_is_author_toggle ()">inf_text_gtk_buffer_is_author_toggle</a>
                                                        (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><span class="type">GtkTextIter</span></a> *iter</code></em>,
                                                         <em class="parameter"><code><a href="../libinftext-0.4/InfTextUser.html"><span class="type">InfTextUser</span></a> **user_on</code></em>,
                                                         <em class="parameter"><code><a href="../libinftext-0.4/InfTextUser.html"><span class="type">InfTextUser</span></a> **user_off</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-forward-to-author-toggle" title="inf_text_gtk_buffer_forward_to_author_toggle ()">inf_text_gtk_buffer_forward_to_author_toggle</a>
                                                        (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><span class="type">GtkTextIter</span></a> *iter</code></em>,
                                                         <em class="parameter"><code><a href="../libinftext-0.4/InfTextUser.html"><span class="type">InfTextUser</span></a> **user_on</code></em>,
                                                         <em class="parameter"><code><a href="../libinftext-0.4/InfTextUser.html"><span class="type">InfTextUser</span></a> **user_off</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-backward-to-author-toggle" title="inf_text_gtk_buffer_backward_to_author_toggle ()">inf_text_gtk_buffer_backward_to_author_toggle</a>
                                                        (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><span class="type">GtkTextIter</span></a> *iter</code></em>,
                                                         <em class="parameter"><code><a href="../libinftext-0.4/InfTextUser.html"><span class="type">InfTextUser</span></a> **user_on</code></em>,
                                                         <em class="parameter"><code><a href="../libinftext-0.4/InfTextUser.html"><span class="type">InfTextUser</span></a> **user_off</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-set-wake-on-cursor-movement" title="inf_text_gtk_buffer_set_wake_on_cursor_movement ()">inf_text_gtk_buffer_set_wake_on_cursor_movement</a>
                                                        (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> wake</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-get-wake-on-cursor-movement" title="inf_text_gtk_buffer_get_wake_on_cursor_movement ()">inf_text_gtk_buffer_get_wake_on_cursor_movement</a>
                                                        (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-ensure-author-tags-priority" title="inf_text_gtk_buffer_ensure_author_tags_priority ()">inf_text_gtk_buffer_ensure_author_tags_priority</a>
                                                        (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-set-saturation-value" title="inf_text_gtk_buffer_set_saturation_value ()">inf_text_gtk_buffer_set_saturation_value</a>
                                                        (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> saturation</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> value</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             <a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-get-saturation" title="inf_text_gtk_buffer_get_saturation ()">inf_text_gtk_buffer_get_saturation</a>  (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             <a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-get-value" title="inf_text_gtk_buffer_get_value ()">inf_text_gtk_buffer_get_value</a>       (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-set-show-user-colors" title="inf_text_gtk_buffer_set_show_user_colors ()">inf_text_gtk_buffer_set_show_user_colors</a>
                                                        (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> show</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-get-show-user-colors" title="inf_text_gtk_buffer_get_show_user_colors ()">inf_text_gtk_buffer_get_show_user_colors</a>
                                                        (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-show-user-colors" title="inf_text_gtk_buffer_show_user_colors ()">inf_text_gtk_buffer_show_user_colors</a>
                                                        (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> show</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><span class="type">GtkTextIter</span></a> *start</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><span class="type">GtkTextIter</span></a> *end</code></em>);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="InfTextGtkBuffer.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----InfTextGtkBuffer
</pre>
</div>
<div class="refsect1" title="Implemented Interfaces">
<a name="InfTextGtkBuffer.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
InfTextGtkBuffer implements
 <a href="../libinfinity-0.4/InfBuffer.html">InfBuffer</a> and  <a href="../libinftext-0.4/libinftext-0.4-inf-text-buffer.html#InfTextBuffer">InfTextBuffer</a>.</p>
</div>
<div class="refsect1" title="Properties">
<a name="InfTextGtkBuffer.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="InfTextGtkBuffer.html#InfTextGtkBuffer--active-user" title='The "active-user" property'>active-user</a>"              <a href="../libinftext-0.4/InfTextUser.html"><span class="type">InfTextUser</span></a>*          : Read / Write
  "<a class="link" href="InfTextGtkBuffer.html#InfTextGtkBuffer--buffer" title='The "buffer" property'>buffer</a>"                   <a href="http://library.gnome.org/devel/gtk/unstable/GtkTextBuffer.html"><span class="type">GtkTextBuffer</span></a>*        : Read / Write / Construct Only
  "<a class="link" href="InfTextGtkBuffer.html#InfTextGtkBuffer--saturation" title='The "saturation" property'>saturation</a>"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write
  "<a class="link" href="InfTextGtkBuffer.html#InfTextGtkBuffer--show-user-colors" title='The "show-user-colors" property'>show-user-colors</a>"         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  "<a class="link" href="InfTextGtkBuffer.html#InfTextGtkBuffer--user-table" title='The "user-table" property'>user-table</a>"               <a href="../libinfinity-0.4/InfUserTable.html"><span class="type">InfUserTable</span></a>*         : Read / Write / Construct Only
  "<a class="link" href="InfTextGtkBuffer.html#InfTextGtkBuffer--value" title='The "value" property'>value</a>"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write
  "<a class="link" href="InfTextGtkBuffer.html#InfTextGtkBuffer--wake-on-cursor-movement" title='The "wake-on-cursor-movement" property'>wake-on-cursor-movement</a>"  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
</pre>
</div>
<div class="refsect1" title="Description">
<a name="InfTextGtkBuffer.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="InfTextGtkBuffer.details"></a><h2>Details</h2>
<div class="refsect2" title="InfTextGtkBuffer">
<a name="InfTextGtkBuffer-struct"></a><h3>InfTextGtkBuffer</h3>
<pre class="programlisting">typedef struct _InfTextGtkBuffer InfTextGtkBuffer;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="inf_text_gtk_buffer_new ()">
<a name="inf-text-gtk-buffer-new"></a><h3>inf_text_gtk_buffer_new ()</h3>
<pre class="programlisting"><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="returnvalue">InfTextGtkBuffer</span></a> *  inf_text_gtk_buffer_new             (<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/GtkTextBuffer.html"><span class="type">GtkTextBuffer</span></a> *buffer</code></em>,
                                                         <em class="parameter"><code><a href="../libinfinity-0.4/InfUserTable.html"><span class="type">InfUserTable</span></a> *user_table</code></em>);</pre>
<p>
Creates a new <a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> wrapping <em class="parameter"><code>buffer</code></em>. It implements the
<a href="../libinftext-0.4/libinftext-0.4-inf-text-buffer.html#InfTextBuffer"><span class="type">InfTextBuffer</span></a> interface by using <em class="parameter"><code>buffer</code></em> to store the text. User colors
are read from the users from <em class="parameter"><code>user_table</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>The underlaying <a href="http://library.gnome.org/devel/gtk/unstable/GtkTextBuffer.html"><span class="type">GtkTextBuffer</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_table</code></em> :</span></p></td>
<td>The <a href="../libinfinity-0.4/InfUserTable.html"><span class="type">InfUserTable</span></a> containing the participating users.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A <a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="inf_text_gtk_buffer_get_text_buffer ()">
<a name="inf-text-gtk-buffer-get-text-buffer"></a><h3>inf_text_gtk_buffer_get_text_buffer ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk/unstable/GtkTextBuffer.html"><span class="returnvalue">GtkTextBuffer</span></a> *     inf_text_gtk_buffer_get_text_buffer (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>);</pre>
<p>
Returns the underlaying <a href="http://library.gnome.org/devel/gtk/unstable/GtkTextBuffer.html"><span class="type">GtkTextBuffer</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>A <a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A <a href="http://library.gnome.org/devel/gtk/unstable/GtkTextBuffer.html"><span class="type">GtkTextBuffer</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="inf_text_gtk_buffer_set_active_user ()">
<a name="inf-text-gtk-buffer-set-active-user"></a><h3>inf_text_gtk_buffer_set_active_user ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                inf_text_gtk_buffer_set_active_user (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>,
                                                         <em class="parameter"><code><a href="../libinftext-0.4/InfTextUser.html"><span class="type">InfTextUser</span></a> *user</code></em>);</pre>
<p>
Sets the active user for <em class="parameter"><code>buffer</code></em>. The active user is the user by which
edits not issued through the <a href="../libinftext-0.4/libinftext-0.4-inf-text-buffer.html#InfTextBuffer"><span class="type">InfTextBuffer</span></a> interface are performed (for
example, edits by the user when the underlaying buffer is displayed in
a <a href="http://library.gnome.org/devel/gtk/unstable/GtkTextView.html"><span class="type">GtkTextView</span></a>).
</p>
<p>
Note that such modifications should not be performed when no active user is
set. Note also the active user must be available and have the
<code class="literal">INF_USER_LOCAL</code> flag set.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>A <a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
<td>A <a href="../libinftext-0.4/InfTextUser.html"><span class="type">InfTextUser</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="inf_text_gtk_buffer_get_active_user ()">
<a name="inf-text-gtk-buffer-get-active-user"></a><h3>inf_text_gtk_buffer_get_active_user ()</h3>
<pre class="programlisting"><a href="../libinftext-0.4/InfTextUser.html"><span class="returnvalue">InfTextUser</span></a> *       inf_text_gtk_buffer_get_active_user (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>);</pre>
<p>
Returns the current active user for <em class="parameter"><code>buffer</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>A <a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A <a href="../libinftext-0.4/InfTextUser.html"><span class="type">InfTextUser</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="inf_text_gtk_buffer_get_author ()">
<a name="inf-text-gtk-buffer-get-author"></a><h3>inf_text_gtk_buffer_get_author ()</h3>
<pre class="programlisting"><a href="../libinftext-0.4/InfTextUser.html"><span class="returnvalue">InfTextUser</span></a> *       inf_text_gtk_buffer_get_author      (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><span class="type">GtkTextIter</span></a> *location</code></em>);</pre>
<p>
Returns the <a href="../libinftext-0.4/InfTextUser.html"><span class="type">InfTextUser</span></a> which wrote the character at <em class="parameter"><code>location</code></em>. If there
is no such user, then <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is returned.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>A <a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>location</code></em> :</span></p></td>
<td>A <a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><span class="type">GtkTextIter</span></a> which is not the end iterator.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A <a href="../libinftext-0.4/InfTextUser.html"><span class="type">InfTextUser</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="inf_text_gtk_buffer_is_author_toggle ()">
<a name="inf-text-gtk-buffer-is-author-toggle"></a><h3>inf_text_gtk_buffer_is_author_toggle ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            inf_text_gtk_buffer_is_author_toggle
                                                        (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><span class="type">GtkTextIter</span></a> *iter</code></em>,
                                                         <em class="parameter"><code><a href="../libinftext-0.4/InfTextUser.html"><span class="type">InfTextUser</span></a> **user_on</code></em>,
                                                         <em class="parameter"><code><a href="../libinftext-0.4/InfTextUser.html"><span class="type">InfTextUser</span></a> **user_off</code></em>);</pre>
<p>
This function returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the author of the text in <em class="parameter"><code>buffer</code></em> changes
at <em class="parameter"><code>iter</code></em>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise. If it returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, then the user who
authored the text to the right hand side of <em class="parameter"><code>iter</code></em> is stored in <em class="parameter"><code>user_on</code></em> (if
non-<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>) and the author of the text to the left hand side of <em class="parameter"><code>iter</code></em> is
stored in <em class="parameter"><code>user_off</code></em> (if non-<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>). Both can also be set to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if there
is unowned text in the buffer or if <em class="parameter"><code>iter</code></em> is at the start or end of the
buffer.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>A <a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>A <a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><span class="type">GtkTextIter</span></a> pointing into <em class="parameter"><code>buffer</code></em>'s underlying <a href="http://library.gnome.org/devel/gtk/unstable/GtkTextBuffer.html"><span class="type">GtkTextBuffer</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_on</code></em> :</span></p></td>
<td>A location to store a <a href="../libinftext-0.4/InfTextUser.html"><span class="type">InfTextUser</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_off</code></em> :</span></p></td>
<td>Another location to store a <a href="../libinftext-0.4/InfTextUser.html"><span class="type">InfTextUser</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Whether text attribution changes at <em class="parameter"><code>iter</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="inf_text_gtk_buffer_forward_to_author_toggle ()">
<a name="inf-text-gtk-buffer-forward-to-author-toggle"></a><h3>inf_text_gtk_buffer_forward_to_author_toggle ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            inf_text_gtk_buffer_forward_to_author_toggle
                                                        (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><span class="type">GtkTextIter</span></a> *iter</code></em>,
                                                         <em class="parameter"><code><a href="../libinftext-0.4/InfTextUser.html"><span class="type">InfTextUser</span></a> **user_on</code></em>,
                                                         <em class="parameter"><code><a href="../libinftext-0.4/InfTextUser.html"><span class="type">InfTextUser</span></a> **user_off</code></em>);</pre>
<p>
Moves <em class="parameter"><code>iter</code></em> to the next point in <em class="parameter"><code>buffer</code></em>'s underlying <a href="http://library.gnome.org/devel/gtk/unstable/GtkTextBuffer.html"><span class="type">GtkTextBuffer</span></a> where
the text has been written by another user. If <em class="parameter"><code>iter</code></em> points to the end of
the buffer, then the function does nothing and returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>. Otherwise
it returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> and sets <em class="parameter"><code>user_on</code></em> to the user which has written the text
on the right hand side of the location <em class="parameter"><code>iter</code></em> has been moved to (if
non-<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>) and <em class="parameter"><code>user_off</code></em> to the user which has written the left hand side
of the location <em class="parameter"><code>iter</code></em> has been moved to.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>A <a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>A <a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><span class="type">GtkTextIter</span></a> pointing into <em class="parameter"><code>buffer</code></em>'s underlying <a href="http://library.gnome.org/devel/gtk/unstable/GtkTextBuffer.html"><span class="type">GtkTextBuffer</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_on</code></em> :</span></p></td>
<td>A location to store a <a href="../libinftext-0.4/InfTextUser.html"><span class="type">InfTextUser</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_off</code></em> :</span></p></td>
<td>Another location to store a <a href="../libinftext-0.4/InfTextUser.html"><span class="type">InfTextUser</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>iter</code></em> was moved, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="inf_text_gtk_buffer_backward_to_author_toggle ()">
<a name="inf-text-gtk-buffer-backward-to-author-toggle"></a><h3>inf_text_gtk_buffer_backward_to_author_toggle ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            inf_text_gtk_buffer_backward_to_author_toggle
                                                        (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><span class="type">GtkTextIter</span></a> *iter</code></em>,
                                                         <em class="parameter"><code><a href="../libinftext-0.4/InfTextUser.html"><span class="type">InfTextUser</span></a> **user_on</code></em>,
                                                         <em class="parameter"><code><a href="../libinftext-0.4/InfTextUser.html"><span class="type">InfTextUser</span></a> **user_off</code></em>);</pre>
<p>
Moves <em class="parameter"><code>iter</code></em> to the previous point in <em class="parameter"><code>buffer</code></em>'s underlying <a href="http://library.gnome.org/devel/gtk/unstable/GtkTextBuffer.html"><span class="type">GtkTextBuffer</span></a>
where the text has been written by another user. If <em class="parameter"><code>iter</code></em> points to the
beginning of the buffer, then the function does nothing and returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.
Otherwise it returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> and sets <em class="parameter"><code>user_on</code></em> to the user which has written
the text on the right hand side of the location <em class="parameter"><code>iter</code></em> has been moved to (if
non-<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>) and <em class="parameter"><code>user_off</code></em> to the user which has written the left hand side
of the location <em class="parameter"><code>iter</code></em> has been moved to.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>A <a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>A <a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><span class="type">GtkTextIter</span></a> pointing into <em class="parameter"><code>buffer</code></em>'s underlying <a href="http://library.gnome.org/devel/gtk/unstable/GtkTextBuffer.html"><span class="type">GtkTextBuffer</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_on</code></em> :</span></p></td>
<td>A location to store a <a href="../libinftext-0.4/InfTextUser.html"><span class="type">InfTextUser</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_off</code></em> :</span></p></td>
<td>Another location to store a <a href="../libinftext-0.4/InfTextUser.html"><span class="type">InfTextUser</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>iter</code></em> was moved, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="inf_text_gtk_buffer_set_wake_on_cursor_movement ()">
<a name="inf-text-gtk-buffer-set-wake-on-cursor-movement"></a><h3>inf_text_gtk_buffer_set_wake_on_cursor_movement ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                inf_text_gtk_buffer_set_wake_on_cursor_movement
                                                        (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> wake</code></em>);</pre>
<p>
This function spcecifies whether movement of the insertion point or
selection bound of the underlying text buffer causes the active user
(see <a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-set-active-user" title="inf_text_gtk_buffer_set_active_user ()"><code class="function">inf_text_gtk_buffer_set_active_user()</code></a>) to become active when its
status is <code class="literal">INF_USER_STATUS_INACTIVE</code>.
</p>
<p>
If <em class="parameter"><code>wake</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, then the user status changes to <code class="literal">INF_USER_STATUS_ACTIVE</code>
in that case. If <em class="parameter"><code>wake</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, then the user status stays
<code class="literal">INF_USER_STATUS_INACTIVE</code>, and its caret-position and selection-length
properties will be no longer be synchronized to the buffer marks until
the user is set active again.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>A <a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>wake</code></em> :</span></p></td>
<td>Whether to make inactive users active on cursor movement.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="inf_text_gtk_buffer_get_wake_on_cursor_movement ()">
<a name="inf-text-gtk-buffer-get-wake-on-cursor-movement"></a><h3>inf_text_gtk_buffer_get_wake_on_cursor_movement ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            inf_text_gtk_buffer_get_wake_on_cursor_movement
                                                        (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>);</pre>
<p>
Returns whether movement of the insertion point or selection bound of the
underlying text buffer causes whether the active user (see
<a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-set-active-user" title="inf_text_gtk_buffer_set_active_user ()"><code class="function">inf_text_gtk_buffer_set_active_user()</code></a>) to become active when its status
is <code class="literal">INF_USER_STATUS_INACTIVE</code>. See also
<a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-set-wake-on-cursor-movement" title="inf_text_gtk_buffer_set_wake_on_cursor_movement ()"><code class="function">inf_text_gtk_buffer_set_wake_on_cursor_movement()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>A <a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Whether to make inactive users active when the insertion mark
is moved.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="inf_text_gtk_buffer_ensure_author_tags_priority ()">
<a name="inf-text-gtk-buffer-ensure-author-tags-priority"></a><h3>inf_text_gtk_buffer_ensure_author_tags_priority ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                inf_text_gtk_buffer_ensure_author_tags_priority
                                                        (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>);</pre>
<p>
Ensures that all author tags have the lowest priority of all tags in the
underlying <a href="http://library.gnome.org/devel/gtk/unstable/GtkTextBuffer.html"><span class="type">GtkTextBuffer</span></a>'s tag table. Normally you do not need to use
this function if you do not set the priority for your tags explicitely.
However, if you do (or are forced to do, because you are using a library
that does this, such as GtkSourceView), then you can call this function
afterwards to make sure all the user tags have the lowest priority.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>A <a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a>.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="inf_text_gtk_buffer_set_saturation_value ()">
<a name="inf-text-gtk-buffer-set-saturation-value"></a><h3>inf_text_gtk_buffer_set_saturation_value ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                inf_text_gtk_buffer_set_saturation_value
                                                        (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> saturation</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> value</code></em>);</pre>
<p>
Sets the saturation and value to use for user colors in a HSV color model.
The hue is defined by each user's individual color. The reason why S and V
are set locally the same for all users is that they can be adjusted
depending on one's theme: Dark themes want dark user colors, bright themes
want bright ones.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>A <a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>saturation</code></em> :</span></p></td>
<td>Saturation to use for user colors.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>Value to use for user colors.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="inf_text_gtk_buffer_get_saturation ()">
<a name="inf-text-gtk-buffer-get-saturation"></a><h3>inf_text_gtk_buffer_get_saturation ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             inf_text_gtk_buffer_get_saturation  (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>);</pre>
<p>
Returns the saturation part of the HSV user color.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>A <a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The saturation used for user colors.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="inf_text_gtk_buffer_get_value ()">
<a name="inf-text-gtk-buffer-get-value"></a><h3>inf_text_gtk_buffer_get_value ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             inf_text_gtk_buffer_get_value       (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>);</pre>
<p>
Returns the value part of the HSV user color.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>A <a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The value used for user colors.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="inf_text_gtk_buffer_set_show_user_colors ()">
<a name="inf-text-gtk-buffer-set-show-user-colors"></a><h3>inf_text_gtk_buffer_set_show_user_colors ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                inf_text_gtk_buffer_set_show_user_colors
                                                        (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> show</code></em>);</pre>
<p>
If <em class="parameter"><code>show</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> (the default), then the user color is used as background
for newly written text by that user. Otherwise, newly written text has no
background color.
</p>
<p>
Note that this setting is for newly written text only. If you want to show
or hide user colors for existing text use
<a class="link" href="InfTextGtkBuffer.html#inf-text-gtk-buffer-show-user-colors" title="inf_text_gtk_buffer_show_user_colors ()"><code class="function">inf_text_gtk_buffer_show_user_colors()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>A <a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>show</code></em> :</span></p></td>
<td>Whether to show user colors or not.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="inf_text_gtk_buffer_get_show_user_colors ()">
<a name="inf-text-gtk-buffer-get-show-user-colors"></a><h3>inf_text_gtk_buffer_get_show_user_colors ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            inf_text_gtk_buffer_get_show_user_colors
                                                        (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>);</pre>
<p>
Returns whether newly written text is attributed with the author's user
color or not.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>A <a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if user color is applied to newly written text, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>
otherwise.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="inf_text_gtk_buffer_show_user_colors ()">
<a name="inf-text-gtk-buffer-show-user-colors"></a><h3>inf_text_gtk_buffer_show_user_colors ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                inf_text_gtk_buffer_show_user_colors
                                                        (<em class="parameter"><code><a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a> *buffer</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> show</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><span class="type">GtkTextIter</span></a> *start</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><span class="type">GtkTextIter</span></a> *end</code></em>);</pre>
<p>
If <em class="parameter"><code>show</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, then don't show user colors (which user wrote what
text) as the background of the text, in the range from <em class="parameter"><code>start</code></em> to <em class="parameter"><code>end</code></em>.
If <em class="parameter"><code>show</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, show user colors if they have previously been hidden
via a call to this function with <em class="parameter"><code>show</code></em> being <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>A <a class="link" href="InfTextGtkBuffer.html" title="InfTextGtkBuffer"><span class="type">InfTextGtkBuffer</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>show</code></em> :</span></p></td>
<td>Whether to show or hide user colors.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>start</code></em> :</span></p></td>
<td>Beginning of the range for which to show or hide user colors.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>end</code></em> :</span></p></td>
<td>End of the range for which to show or hide user colors.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="InfTextGtkBuffer.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "active-user" property'>
<a name="InfTextGtkBuffer--active-user"></a><h3>The <code class="literal">"active-user"</code> property</h3>
<pre class="programlisting">  "active-user"              <a href="../libinftext-0.4/InfTextUser.html"><span class="type">InfTextUser</span></a>*          : Read / Write</pre>
<p>The user currently inserting text locally.</p>
</div>
<hr>
<div class="refsect2" title='The "buffer" property'>
<a name="InfTextGtkBuffer--buffer"></a><h3>The <code class="literal">"buffer"</code> property</h3>
<pre class="programlisting">  "buffer"                   <a href="http://library.gnome.org/devel/gtk/unstable/GtkTextBuffer.html"><span class="type">GtkTextBuffer</span></a>*        : Read / Write / Construct Only</pre>
<p>The underlaying GtkTextBuffer.</p>
</div>
<hr>
<div class="refsect2" title='The "saturation" property'>
<a name="InfTextGtkBuffer--saturation"></a><h3>The <code class="literal">"saturation"</code> property</h3>
<pre class="programlisting">  "saturation"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write</pre>
<p>Saturation of user colors in a HSV color model.</p>
<p>Allowed values: [0,1]</p>
<p>Default value: 0.35</p>
</div>
<hr>
<div class="refsect2" title='The "show-user-colors" property'>
<a name="InfTextGtkBuffer--show-user-colors"></a><h3>The <code class="literal">"show-user-colors"</code> property</h3>
<pre class="programlisting">  "show-user-colors"         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
<p>Whether to show user colors initially for newly written text.</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2" title='The "user-table" property'>
<a name="InfTextGtkBuffer--user-table"></a><h3>The <code class="literal">"user-table"</code> property</h3>
<pre class="programlisting">  "user-table"               <a href="../libinfinity-0.4/InfUserTable.html"><span class="type">InfUserTable</span></a>*         : Read / Write / Construct Only</pre>
<p>A user table of the participating users.</p>
</div>
<hr>
<div class="refsect2" title='The "value" property'>
<a name="InfTextGtkBuffer--value"></a><h3>The <code class="literal">"value"</code> property</h3>
<pre class="programlisting">  "value"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write</pre>
<p>Value of user colors in a HSV color model.</p>
<p>Allowed values: [0,1]</p>
<p>Default value: 1</p>
</div>
<hr>
<div class="refsect2" title='The "wake-on-cursor-movement" property'>
<a name="InfTextGtkBuffer--wake-on-cursor-movement"></a><h3>The <code class="literal">"wake-on-cursor-movement"</code> property</h3>
<pre class="programlisting">  "wake-on-cursor-movement"  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
<p>Whether to make inactive users active when the insertion mark in the TextBuffer moves.</p>
<p>Default value: FALSE</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.15</div>
</body>
</html>